SCHED: GetTaskGroupReportJson
Format
SCHED / GetTaskGroupReportJson '<TaskGroupName>' '<FileName>'
Description
The SCHED GetTaskGroupReportJson Connect command returns a detailed report of the task group/(s) specified by the <TaskGroupName> parameter in JSON format. The output will be formatted as a JSON array, even if information on only a single task group is requested. Each element in this JSON array maps to a single task group.
GetTaskGroupReportJson vs. GetTaskGroupReport
The choice of command will depend on use case.
SCHED GetTaskGroupReportJson provides output in a commonly used format that is easy to parse. This command is preferred if task group information will be further processed.
SCHED GetTaskGroupReport provides output that is difficult to parse but easy to understand. This command is preferred if no further processing is required.
Parameters
- TaskGroupName: The parameter is a string of text in single quotes of a comma delimited list of task groups. Task group names should not be in quotes and "ALL" may be used to return all task groups present in the schedule. Supports the use of wildcards.
- FileName: The parameter is a string of text in single quotes of the absolute path file name. Empty string is allowed if it is not written out to a file.
Examples
Requests all Task Group reports for the active schedule to the file "TaskGroupReport.json" located at
"C:\Outputs\"
SCHED / GetTaskGroupReportJson 'ALL' 'C:\Outputs\TaskGroupReport.json'
| Syntax | Example |
|---|---|
| <CommandName> | SCHED / GetTaskGroupReport |
| <TaskGroupName> | 'ALL' |
| <FileName> | 'C:\Outputs\TaskGroupReport.json' |
Return Message
Connect returns a message that contains all of the report data for the task group(s) in JSON format.
The following JSON file contains sample output of the above command.
Group Membership
This command belongs to the following group(s):
Version
12.0
